<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Installing &mdash; Paramiko  documentation</title>
    
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Paramiko  documentation" href="index.html" />
    <link rel="next" title="Installing (1.x)" href="installing-1.x.html" />
    <link rel="prev" title="Frequently Asked/Answered Questions" href="faq.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body role="document">
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="installing">
<h1>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These instructions cover Paramiko 2.0 and above. If you&#8217;re looking to
install Paramiko 1.x, see <a class="reference internal" href="installing-1.x.html"><span class="doc">Installing (1.x)</span></a>. However, <strong>the 1.x line
relies on insecure dependencies</strong> so upgrading is strongly encouraged.</p>
</div>
<div class="section" id="paramiko-itself">
<span id="id1"></span><h2>Paramiko itself<a class="headerlink" href="#paramiko-itself" title="Permalink to this headline">¶</a></h2>
<p>The recommended way to get Paramiko is to <strong>install the latest stable release</strong>
via <a class="reference external" href="http://pip-installer.org">pip</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install paramiko
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Users who want the bleeding edge can install the development version via
<code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">paramiko==dev</span></code>.</p>
</div>
<p>We currently support <strong>Python 2.6, 2.7, 3.3+, and PyPy</strong>. Users on Python 2.5
or older (or 3.2 or older) are urged to upgrade.</p>
<p>Paramiko has only one direct hard dependency: the Cryptography library. See
<a class="reference internal" href="#cryptography"><span class="std std-ref">Cryptography</span></a>.</p>
<p>If you need GSS-API / SSPI support, see <a class="reference internal" href="#gssapi"><span class="std std-ref">the below subsection on it</span></a> for details on its optional dependencies.</p>
<div class="section" id="release-lines">
<span id="id2"></span><h3>Release lines<a class="headerlink" href="#release-lines" title="Permalink to this headline">¶</a></h3>
<p>Users desiring stability may wish to pin themselves to a specific release line
once they first start using Paramiko; to assist in this, we guarantee bugfixes
for the last 2-3 releases including the latest stable one.</p>
<p>This typically spans major &amp; minor versions, so even if e.g. 3.1 is the latest
stable release, it&#8217;s likely that bugfixes will occasionally come out for the
latest 2.x and perhaps even 1.x releases, as well as for 3.0. New feature
releases for previous major-version lines are less likely but not unheard of.</p>
<p>If you&#8217;re unsure which version to install:</p>
<ul class="simple">
<li><strong>Completely new users</strong> should always default to the <strong>latest stable
release</strong> (as above, whatever is newest / whatever shows up with <code class="docutils literal"><span class="pre">pip</span>
<span class="pre">install</span> <span class="pre">paramiko</span></code>.)</li>
<li><strong>Users upgrading from a much older version</strong> (e.g. 1.7.x through 1.10.x)
should probably get the <strong>oldest actively supported line</strong> (check the
<a class="reference internal" href="changelog.html"><span class="doc">Changelog</span></a> for recent releases).</li>
<li><strong>Everybody else</strong> is hopefully already &#8220;on&#8221; a given version and can
carefully upgrade to whichever version they care to, when their release line
stops being supported.</li>
</ul>
</div>
</div>
<div class="section" id="cryptography">
<span id="id3"></span><h2>Cryptography<a class="headerlink" href="#cryptography" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://cryptography.io">Cryptography</a>  provides the low-level (C-based)
encryption algorithms we need to implement the SSH protocol. It has detailed
<a class="reference external" href="https://cryptography.io/en/latest/installation/">installation instructions</a> (and an <a class="reference external" href="https://cryptography.io/en/latest/faq/">FAQ</a>) which you should read carefully.</p>
<p>In general, you&#8217;ll need one of the following setups:</p>
<ul>
<li><p class="first">On Windows or Mac OS X, provided your <code class="docutils literal"><span class="pre">pip</span></code> is modern (8.x+): nothing else
is required. <code class="docutils literal"><span class="pre">pip</span></code> will install statically compiled binary archives of
Cryptography &amp; its dependencies.</p>
</li>
<li><p class="first">On Linux, or on other platforms with older versions of <code class="docutils literal"><span class="pre">pip</span></code>: you&#8217;ll need a
C build toolchain, plus development headers for Python, OpenSSL and
<code class="docutils literal"><span class="pre">libffi</span></code>. Again, see <a class="reference external" href="https://cryptography.io/en/latest/installation/">Cryptography&#8217;s install docs</a>; these requirements may
occasionally change.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you go this route, note that <strong>OpenSSL 1.0.1 or newer is effectively
required</strong>. Cryptography 1.3 and older technically allow OpenSSL 0.9.8, but
1.4 and newer - which Paramiko will gladly install or upgrade, if you e.g.
<code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-U</span></code> - drop that support.</p>
</div>
</li>
</ul>
</div>
<div class="section" id="optional-dependencies-for-gss-api-sspi-kerberos">
<span id="gssapi"></span><h2>Optional dependencies for GSS-API / SSPI / Kerberos<a class="headerlink" href="#optional-dependencies-for-gss-api-sspi-kerberos" title="Permalink to this headline">¶</a></h2>
<p>In order to use GSS-API/Kerberos &amp; related functionality, a couple of
additional dependencies are required (these are not listed in our <code class="docutils literal"><span class="pre">setup.py</span></code>
due to their infrequent utility &amp; non-platform-agnostic requirements):</p>
<ul>
<li><p class="first">It hopefully goes without saying but <strong>all platforms</strong> need <strong>a working
installation of GSS-API itself</strong>, e.g. Heimdal.</p>
</li>
<li><p class="first"><strong>Unix</strong> needs <a class="reference external" href="https://pypi.python.org/pypi/python-gssapi/">python-gssapi</a>
<code class="docutils literal"><span class="pre">0.6.1</span></code> or better.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This library appears to only function on Python 2.7 and up.</p>
</div>
</li>
<li><p class="first"><strong>Windows</strong> needs <a class="reference external" href="https://pypi.python.org/pypi/pywin32">pywin32</a> <code class="docutils literal"><span class="pre">2.1.8</span></code>
or better.</p>
</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you use Microsoft SSPI for kerberos authentication and credential
delegation, make sure that the target host is trusted for delegation in the
active directory configuration. For details see:
<a class="reference external" href="http://technet.microsoft.com/en-us/library/cc738491%28v=ws.10%29.aspx">http://technet.microsoft.com/en-us/library/cc738491%28v=ws.10%29.aspx</a></p>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Paramiko</a></h1>



<p class="blurb">A Python implementation of SSHv2.</p>




<p>
<iframe src="https://ghbtns.com/github-btn.html?user=paramiko&repo=paramiko&type=watch&count=true&size=large&v=2"
  allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>





    

<p>
<a href="https://travis-ci.org/paramiko/paramiko">
    <img
        alt="https://secure.travis-ci.org/paramiko/paramiko.svg?branch=master"
        src="https://secure.travis-ci.org/paramiko/paramiko.svg?branch=master"
    />
</a>
</p>


<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#paramiko-itself">Paramiko itself</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#release-lines">Release lines</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#cryptography">Cryptography</a></li>
<li class="toctree-l2"><a class="reference internal" href="#optional-dependencies-for-gss-api-sspi-kerberos">Optional dependencies for GSS-API / SSPI / Kerberos</a><ul>
<li class="toctree-l3"><a class="reference internal" href="installing-1.x.html">Installing (1.x)</a></li>
<li class="toctree-l3"><a class="reference internal" href="installing-1.x.html#general-install-notes">General install notes</a></li>
<li class="toctree-l3"><a class="reference internal" href="installing-1.x.html#pycrypto">PyCrypto</a></li>
<li class="toctree-l3"><a class="reference internal" href="installing-1.x.html#activepython-and-pypm">ActivePython and PyPM</a></li>
<li class="toctree-l3"><a class="reference internal" href="installing-1.x.html#optional-dependencies-for-gss-api-sspi-kerberos">Optional dependencies for GSS-API / SSPI / Kerberos</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li>
</ul>


<hr />
<ul>
    
    <li class="toctree-l1"><a href="http://docs.paramiko.org">API Docs</a></li>
    
</ul>

<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2016 Jeff Forcier.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/installing.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
    <script type="text/javascript">

      var _gaq = _gaq || [];
      _gaq.push(['_setAccount', 'UA-18486793-2']);
      _gaq.push(['_setDomainName', 'none']);
      _gaq.push(['_setAllowLinker', true]);
      _gaq.push(['_trackPageview']);

      (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
      })();

    </script>
    
  </body>
</html>